home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / X11 / XSetScreenSaver.z / XSetScreenSaver
Encoding:
Text File  |  2002-10-03  |  9.2 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXSSSSeeeettttSSSSccccrrrreeeeeeeennnnSSSSaaaavvvveeeerrrr((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSeeeettttSSSSccccrrrreeeeeeeennnnSSSSaaaavvvveeeerrrr((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XSetScreenSaver, XForceScreenSaver, XActivateScreenSaver,
  10.           XResetScreenSaver, XGetScreenSaver - manipulate the screen
  11.           saver
  12.  
  13.      SSSSYYYYNNNNTTTTAAAAXXXX
  14.           XSetScreenSaver(_d_i_s_p_l_a_y, _t_i_m_e_o_u_t, _i_n_t_e_r_v_a_l, _p_r_e_f_e_r__b_l_a_n_k_i_n_g,
  15.           _a_l_l_o_w__e_x_p_o_s_u_r_e_s)
  16.                 Display *_d_i_s_p_l_a_y;
  17.                 int _t_i_m_e_o_u_t, _i_n_t_e_r_v_a_l;
  18.                 int _p_r_e_f_e_r__b_l_a_n_k_i_n_g;
  19.                 int _a_l_l_o_w__e_x_p_o_s_u_r_e_s;
  20.  
  21.           XForceScreenSaver(_d_i_s_p_l_a_y, _m_o_d_e)
  22.                 Display *_d_i_s_p_l_a_y;
  23.                 int _m_o_d_e;
  24.  
  25.           XActivateScreenSaver(_d_i_s_p_l_a_y)
  26.                 Display *_d_i_s_p_l_a_y;
  27.  
  28.           XResetScreenSaver(_d_i_s_p_l_a_y)
  29.                 Display *_d_i_s_p_l_a_y;
  30.  
  31.           XGetScreenSaver(_d_i_s_p_l_a_y, _t_i_m_e_o_u_t__r_e_t_u_r_n, _i_n_t_e_r_v_a_l__r_e_t_u_r_n,
  32.           _p_r_e_f_e_r__b_l_a_n_k_i_n_g__r_e_t_u_r_n,
  33.                             _a_l_l_o_w__e_x_p_o_s_u_r_e_s__r_e_t_u_r_n)
  34.                 Display *_d_i_s_p_l_a_y;
  35.                 int *_t_i_m_e_o_u_t__r_e_t_u_r_n, *_i_n_t_e_r_v_a_l__r_e_t_u_r_n;
  36.                 int *_p_r_e_f_e_r__b_l_a_n_k_i_n_g__r_e_t_u_r_n;
  37.                 int *_a_l_l_o_w__e_x_p_o_s_u_r_e_s__r_e_t_u_r_n;
  38.  
  39.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  40.           _a_l_l_o_w__e_x_p_o_s_u_r_e_s
  41.                     Specifies the screen save control values.  You can
  42.                     pass _D_o_n_t_A_l_l_o_w_E_x_p_o_s_u_r_e_s, _A_l_l_o_w_E_x_p_o_s_u_r_e_s, or
  43.                     _D_e_f_a_u_l_t_E_x_p_o_s_u_r_e_s.
  44.  
  45.           _a_l_l_o_w__e_x_p_o_s_u_r_e_s__r_e_t_u_r_n
  46.                     Returns the current screen save control value
  47.                     (_D_o_n_t_A_l_l_o_w_E_x_p_o_s_u_r_e_s, _A_l_l_o_w_E_x_p_o_s_u_r_e_s, or
  48.                     _D_e_f_a_u_l_t_E_x_p_o_s_u_r_e_s).
  49.  
  50.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  51.  
  52.           _i_n_t_e_r_v_a_l  Specifies the interval, in seconds, between screen
  53.                     saver alterations.
  54.  
  55.           _i_n_t_e_r_v_a_l__r_e_t_u_r_n
  56.                     Returns the interval between screen saver
  57.                     invocations.
  58.  
  59.           _m_o_d_e      Specifies the mode that is to be applied.  You can
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXSSSSeeeettttSSSSccccrrrreeeeeeeennnnSSSSaaaavvvveeeerrrr((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSeeeettttSSSSccccrrrreeeeeeeennnnSSSSaaaavvvveeeerrrr((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.                     pass _S_c_r_e_e_n_S_a_v_e_r_A_c_t_i_v_e or _S_c_r_e_e_n_S_a_v_e_r_R_e_s_e_t.
  75.  
  76.           _p_r_e_f_e_r__b_l_a_n_k_i_n_g
  77.                     Specifies how to enable screen blanking.  You can
  78.                     pass _D_o_n_t_P_r_e_f_e_r_B_l_a_n_k_i_n_g, _P_r_e_f_e_r_B_l_a_n_k_i_n_g, or
  79.                     _D_e_f_a_u_l_t_B_l_a_n_k_i_n_g.
  80.  
  81.           _p_r_e_f_e_r__b_l_a_n_k_i_n_g__r_e_t_u_r_n
  82.                     Returns the current screen blanking preference
  83.                     (_D_o_n_t_P_r_e_f_e_r_B_l_a_n_k_i_n_g, _P_r_e_f_e_r_B_l_a_n_k_i_n_g, or
  84.                     _D_e_f_a_u_l_t_B_l_a_n_k_i_n_g).
  85.  
  86.           _t_i_m_e_o_u_t   Specifies the timeout, in seconds, until the
  87.                     screen saver turns on.
  88.  
  89.           _t_i_m_e_o_u_t__r_e_t_u_r_n
  90.                     Returns the timeout, in seconds, until the screen
  91.                     saver turns on.
  92.  
  93.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  94.           Timeout and interval are specified in seconds. A timeout of
  95.           0 disables the screen saver (but an activated screen saver
  96.           is not deactivated), and a timeout of -1 restores the
  97.           default.  Other negative values generate a _B_a_d_V_a_l_u_e error.
  98.           If the timeout value is nonzero, _X_S_e_t_S_c_r_e_e_n_S_a_v_e_r enables the
  99.           screen saver.  An interval of 0 disables the random-pattern
  100.           motion.  If no input from devices (keyboard, mouse, and so
  101.           on) is generated for the specified number of timeout seconds
  102.           once the screen saver is enabled, the screen saver is
  103.           activated.
  104.  
  105.           For each screen, if blanking is preferred and the hardware
  106.           supports video blanking, the screen simply goes blank.
  107.           Otherwise, if either exposures are allowed or the screen can
  108.           be regenerated without sending _E_x_p_o_s_e events to clients, the
  109.           screen is tiled with the root window background tile
  110.           randomly re-origined each interval seconds.  Otherwise, the
  111.           screens' state do not change, and the screen saver is not
  112.           activated.  The screen saver is deactivated, and all screen
  113.           states are restored at the next keyboard or pointer input or
  114.           at the next call to _X_F_o_r_c_e_S_c_r_e_e_n_S_a_v_e_r with mode
  115.           _S_c_r_e_e_n_S_a_v_e_r_R_e_s_e_t.
  116.  
  117.           If the server-dependent screen saver method supports
  118.           periodic change, the interval argument serves as a hint
  119.           about how long the change period should be, and zero hints
  120.           that no periodic change should be made.  Examples of ways to
  121.           change the screen include scrambling the colormap
  122.           periodically, moving an icon image around the screen
  123.           periodically, or tiling the screen with the root window
  124.           background tile, randomly re-origined periodically.
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXSSSSeeeettttSSSSccccrrrreeeeeeeennnnSSSSaaaavvvveeeerrrr((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSeeeettttSSSSccccrrrreeeeeeeennnnSSSSaaaavvvveeeerrrr((((3333XXXX11111111))))
  137.  
  138.  
  139.  
  140.           _X_S_e_t_S_c_r_e_e_n_S_a_v_e_r can generate a _B_a_d_V_a_l_u_e error.
  141.  
  142.           If the specified mode is _S_c_r_e_e_n_S_a_v_e_r_A_c_t_i_v_e and the screen
  143.           saver currently is deactivated, _X_F_o_r_c_e_S_c_r_e_e_n_S_a_v_e_r activates
  144.           the screen saver even if the screen saver had been disabled
  145.           with a timeout of zero.  If the specified mode is
  146.           _S_c_r_e_e_n_S_a_v_e_r_R_e_s_e_t and the screen saver currently is enabled,
  147.           _X_F_o_r_c_e_S_c_r_e_e_n_S_a_v_e_r deactivates the screen saver if it was
  148.           activated, and the activation timer is reset to its initial
  149.           state (as if device input had been received).
  150.  
  151.           _X_F_o_r_c_e_S_c_r_e_e_n_S_a_v_e_r can generate a _B_a_d_V_a_l_u_e error.
  152.  
  153.           The _X_A_c_t_i_v_a_t_e_S_c_r_e_e_n_S_a_v_e_r function activates the screen
  154.           saver.
  155.  
  156.           The _X_R_e_s_e_t_S_c_r_e_e_n_S_a_v_e_r function resets the screen saver.
  157.  
  158.           The _X_G_e_t_S_c_r_e_e_n_S_a_v_e_r function gets the current screen saver
  159.           values.
  160.  
  161.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  162.           _B_a_d_V_a_l_u_e  Some numeric value falls outside the range of
  163.                     values accepted by the request.  Unless a specific
  164.                     range is specified for an argument, the full range
  165.                     defined by the argument's type is accepted.  Any
  166.                     argument defined as a set of alternatives can
  167.                     generate this error.
  168.  
  169.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  170.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.